<!DOCTYPE html>
<html lang="en">
<head>
<title>Brook Tardigrade: BrookHTTPUploads: Packed Record TBrookHTTPUpload</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="generator" content="PasDoc 0.16.0">
<meta http-equiv="content-type" content="text/html; charset=utf-8">
<link rel="stylesheet" type="text/css" href="tipuesearch/tipuesearch.css">

<link rel="StyleSheet" type="text/css" href="pasdoc.css">
</head>
<body>
<div class="container"><div class="navigation">
<h2><a href="index.html">Brook Tardigrade</a></h2><ul><li><a href="AllUnits.html">Units</a></li><li><a href="ClassHierarchy.html">Class Hierarchy</a></li><li><a href="AllClasses.html">Classes, Interfaces, Objects and Records</a></li><li><a href="AllTypes.html">Types</a></li><li><a href="AllVariables.html">Variables</a></li><li><a href="AllConstants.html">Constants</a></li><li><a href="AllFunctions.html">Functions and Procedures</a></li><li><a href="AllIdentifiers.html">Identifiers</a></li><li><form class="search-form" action="tipue_results.html"><div class="search-input"><input type="text" name="q" id="tipue_search_input" pattern=".{3,}" title="At least 3 characters" required><div class="search-button"><input type="button" id="tipue_search_button" onclick="this.form.submit();"></div></div></form>
<div style="clear: both"></div>
</li></ul></div><div class="content">
<span id="TBrookHTTPUpload"></span><h1 class="cio">Packed Record TBrookHTTPUpload</h1>
<div class="sections">
<div class="one_section"><a class="section" href="#PasDoc-Description">Description</a></div><div class="one_section">Hierarchy</div><div class="one_section">Fields</div><div class="one_section"><a class="section" href="#PasDoc-Methods">Methods</a></div><div class="one_section"><a class="section" href="#PasDoc-Properties">Properties</a></div></div>
<span id="PasDoc-Description"></span><h2 class="unit">Unit</h2>
<p class="unitlink">
<a href="BrookHTTPUploads.html">BrookHTTPUploads</a></p>
<h2 class="declaration">Declaration</h2>
<p class="declaration">
<code>type TBrookHTTPUpload = packed record</code></p>
<h2 class="description">Description</h2>
<p>
Structured type which holds the upload properties and allows to <a class="normal" href="BrookHTTPUploads.TBrookHTTPUpload.html#Save">save</a> the uploaded file.</p>
<h2 class="overview">Overview</h2>
<span id="PasDoc-Methods"></span><h3 class="summary">Methods</h3>
<table class="summary wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>constructor <strong><a href="BrookHTTPUploads.TBrookHTTPUpload.html#Create">Create</a></strong>(AHandle: Pointer);</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>function <strong><a href="BrookHTTPUploads.TBrookHTTPUpload.html#Save">Save</a></strong>(AOverwritten: Boolean; out AError: string): Boolean; overload;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>function <strong><a href="BrookHTTPUploads.TBrookHTTPUpload.html#Save">Save</a></strong>(out AError: string): Boolean; overload;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>procedure <strong><a href="BrookHTTPUploads.TBrookHTTPUpload.html#Save">Save</a></strong>(AOverwritten: Boolean); overload;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>procedure <strong><a href="BrookHTTPUploads.TBrookHTTPUpload.html#Save">Save</a></strong>; overload;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>function <strong><a href="BrookHTTPUploads.TBrookHTTPUpload.html#SaveAs">SaveAs</a></strong>(const APath: TFileName; AOverwritten: Boolean; out AError: string): Boolean; overload;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>function <strong><a href="BrookHTTPUploads.TBrookHTTPUpload.html#SaveAs">SaveAs</a></strong>(const APath: TFileName; out AError: string): Boolean; overload;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>procedure <strong><a href="BrookHTTPUploads.TBrookHTTPUpload.html#SaveAs">SaveAs</a></strong>(const APath: TFileName; AOverwritten: Boolean); overload;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>procedure <strong><a href="BrookHTTPUploads.TBrookHTTPUpload.html#SaveAs">SaveAs</a></strong>(const APath: TFileName); overload;</code></td>
</tr>
</table>
<span id="PasDoc-Properties"></span><h3 class="summary">Properties</h3>
<table class="summary wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>property <strong><a href="BrookHTTPUploads.TBrookHTTPUpload.html#Handle">Handle</a></strong>: Pointer read GetHandle;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>property <strong><a href="BrookHTTPUploads.TBrookHTTPUpload.html#StreamHandle">StreamHandle</a></strong>: Pointer read FStreamHandle;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>property <strong><a href="BrookHTTPUploads.TBrookHTTPUpload.html#Directory">Directory</a></strong>: string read FDirectory;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>property <strong><a href="BrookHTTPUploads.TBrookHTTPUpload.html#Field">Field</a></strong>: string read FField;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>property <strong><a href="BrookHTTPUploads.TBrookHTTPUpload.html#Name">Name</a></strong>: string read FName;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>property <strong><a href="BrookHTTPUploads.TBrookHTTPUpload.html#Mime">Mime</a></strong>: string read FMime;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>property <strong><a href="BrookHTTPUploads.TBrookHTTPUpload.html#Encoding">Encoding</a></strong>: string read FEncoding;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>property <strong><a href="BrookHTTPUploads.TBrookHTTPUpload.html#Size">Size</a></strong>: UInt64 read FSize;</code></td>
</tr>
</table>
<h2 class="description">Description</h2>
<h3 class="detail">Methods</h3>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="Create"></span><code>constructor <strong>Create</strong>(AHandle: Pointer);</code></td>
</tr>
<tr><td colspan="2">
<p>
Creates an instance of <code><a class="normal" href="BrookHTTPUploads.TBrookHTTPUpload.html">TBrookHTTPUpload</a></code>. </p>
<h6 class="description_section">Parameters</h6>
<dl class="parameters">
<dt>AHandle[in]</dt>
<dd>Upload <a class="normal" href="BrookHTTPUploads.TBrookHTTPUpload.html#Handle">handle</a>.</dd>
</dl>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="Save"></span><code>function <strong>Save</strong>(AOverwritten: Boolean; out AError: string): Boolean; overload;</code></td>
</tr>
<tr><td colspan="2">
<p>
Saves the uploaded file defining the destination path by upload <a class="normal" href="BrookHTTPUploads.TBrookHTTPUpload.html#Name">name</a> and <a class="normal" href="BrookHTTPUploads.TBrookHTTPUpload.html#Directory">directory</a>.   </p>
<h6 class="description_section">Parameters</h6>
<dl class="parameters">
<dt>AOverwritten[in]</dt>
<dd>Overwrite upload file if it exists.</dd>
<dt>AError[out]</dt>
<dd>Variable reference to store string describing the error if <a class="normal" href="BrookHTTPUploads.TBrookHTTPUpload.html#Save">save</a> fails.</dd>
</dl>
<h6 class="description_section">Returns</h6>
<p class="return"><code>True</code> if the uploaded file is saved successfully.</p></td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="Save"></span><code>function <strong>Save</strong>(out AError: string): Boolean; overload;</code></td>
</tr>
<tr><td colspan="2">
<p>
Saves the uploaded file defining the destination path by upload <a class="normal" href="BrookHTTPUploads.TBrookHTTPUpload.html#Name">name</a> and <a class="normal" href="BrookHTTPUploads.TBrookHTTPUpload.html#Directory">directory</a>.  </p>
<h6 class="description_section">Parameters</h6>
<dl class="parameters">
<dt>AError[out]</dt>
<dd>Variable reference to store string describing the error if <a class="normal" href="BrookHTTPUploads.TBrookHTTPUpload.html#Save">save</a> fails.</dd>
</dl>
<h6 class="description_section">Returns</h6>
<p class="return"><code>True</code> if the uploaded file is saved successfully.</p></td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="Save"></span><code>procedure <strong>Save</strong>(AOverwritten: Boolean); overload;</code></td>
</tr>
<tr><td colspan="2">
<p>
Saves the uploaded file defining the destination path by upload <a class="normal" href="BrookHTTPUploads.TBrookHTTPUpload.html#Name">name</a> and <a class="normal" href="BrookHTTPUploads.TBrookHTTPUpload.html#Directory">directory</a>. </p>
<h6 class="description_section">Parameters</h6>
<dl class="parameters">
<dt>AOverwritten[in]</dt>
<dd>Overwrite upload file if it exists.</dd>
</dl>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="Save"></span><code>procedure <strong>Save</strong>; overload;</code></td>
</tr>
<tr><td colspan="2">
<p>
Saves the uploaded file defining the destination path by upload <a class="normal" href="BrookHTTPUploads.TBrookHTTPUpload.html#Name">name</a> and <a class="normal" href="BrookHTTPUploads.TBrookHTTPUpload.html#Directory">directory</a>.</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="SaveAs"></span><code>function <strong>SaveAs</strong>(const APath: TFileName; AOverwritten: Boolean; out AError: string): Boolean; overload;</code></td>
</tr>
<tr><td colspan="2">
<p>
Saves the uploaded file allowing to define the destination path.    </p>
<h6 class="description_section">Parameters</h6>
<dl class="parameters">
<dt>APath[in]</dt>
<dd>Absolute destination path.</dd>
<dt>AOverwritten[in]</dt>
<dd>Overwrite upload file if it exists.</dd>
<dt>AError[out]</dt>
<dd>Variable reference to store string describing the error if <a class="normal" href="BrookHTTPUploads.TBrookHTTPUpload.html#Save">save</a> fails.</dd>
</dl>
<h6 class="description_section">Returns</h6>
<p class="return"><code>True</code> if the uploaded file is saved successfully.</p></td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="SaveAs"></span><code>function <strong>SaveAs</strong>(const APath: TFileName; out AError: string): Boolean; overload;</code></td>
</tr>
<tr><td colspan="2">
<p>
Saves the uploaded file allowing to define the destination path.   </p>
<h6 class="description_section">Parameters</h6>
<dl class="parameters">
<dt>APath[in]</dt>
<dd>Absolute destination path.</dd>
<dt>AError[out]</dt>
<dd>Variable reference to store string describing the error if <a class="normal" href="BrookHTTPUploads.TBrookHTTPUpload.html#Save">save</a> fails.</dd>
</dl>
<h6 class="description_section">Returns</h6>
<p class="return"><code>True</code> if the uploaded file is saved successfully.</p></td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="SaveAs"></span><code>procedure <strong>SaveAs</strong>(const APath: TFileName; AOverwritten: Boolean); overload;</code></td>
</tr>
<tr><td colspan="2">
<p>
Saves the uploaded file allowing to define the destination path.  </p>
<h6 class="description_section">Parameters</h6>
<dl class="parameters">
<dt>APath[in]</dt>
<dd>Absolute destination path.</dd>
<dt>AOverwritten[in]</dt>
<dd>Overwrite upload file if it exists.</dd>
</dl>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="SaveAs"></span><code>procedure <strong>SaveAs</strong>(const APath: TFileName); overload;</code></td>
</tr>
<tr><td colspan="2">
<p>
Saves the uploaded file allowing to define the destination path. </p>
<h6 class="description_section">Parameters</h6>
<dl class="parameters">
<dt>APath[in]</dt>
<dd>Absolute destination path.</dd>
</dl>
</td></tr>
</table>
<h3 class="detail">Properties</h3>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="Handle"></span><code>property <strong>Handle</strong>: Pointer read GetHandle;</code></td>
</tr>
<tr><td colspan="2">
<p>
<code>Handle</code> of an upload.</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="StreamHandle"></span><code>property <strong>StreamHandle</strong>: Pointer read FStreamHandle;</code></td>
</tr>
<tr><td colspan="2">
<p>
Stream <a class="normal" href="BrookHTTPUploads.TBrookHTTPUpload.html#Handle">handle</a> of the upload.</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="Directory"></span><code>property <strong>Directory</strong>: string read FDirectory;</code></td>
</tr>
<tr><td colspan="2">
<p>
<code>Directory</code> of the uploaded file.</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="Field"></span><code>property <strong>Field</strong>: string read FField;</code></td>
</tr>
<tr><td colspan="2">
<p>
<code>Field</code> <a class="normal" href="BrookHTTPUploads.TBrookHTTPUpload.html#Name">name</a> of the upload.</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="Name"></span><code>property <strong>Name</strong>: string read FName;</code></td>
</tr>
<tr><td colspan="2">
<p>
<code>Name</code> of the uploaded file.</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="Mime"></span><code>property <strong>Mime</strong>: string read FMime;</code></td>
</tr>
<tr><td colspan="2">
<p>
<code>MIME</code> (content-type) of the upload.</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="Encoding"></span><code>property <strong>Encoding</strong>: string read FEncoding;</code></td>
</tr>
<tr><td colspan="2">
<p>
<code>Encoding</code> (transfer-<code>encoding</code>) of the upload.</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="Size"></span><code>property <strong>Size</strong>: UInt64 read FSize;</code></td>
</tr>
<tr><td colspan="2">
<p>
<code>Size</code> of the upload.</p>
</td></tr>
</table>
<hr><span class="appinfo"><em>Generated by <a href="https://pasdoc.github.io/">PasDoc 0.16.0</a>. </em>
</span>
</div></div></body></html>
